home *** CD-ROM | disk | FTP | other *** search
/ Ham Radio 2000 / Ham Radio 2000.iso / ham2000 / packet / aprs75c / protocol.txt < prev    next >
Text File  |  1995-11-29  |  14KB  |  250 lines
  1. PROTOCOL.txt 7.4c     APRS ON-AIR PROTOCOLS and FORMATS
  2.  
  3.  
  4. COPYRIGHT 1992,93,94,95,96:  Amateur radio operators may freely copy and use
  5. APRS in the Amateur Radio Service, and should not feel compelled to register.
  6. I have tried to make APRS fully capable of RECEIVING and plotting ALL on-
  7. the-air packets whether a station is registered or not.  I ask for a
  8. contribution only to balance the headache factor, and to cover myself
  9. against un-licensed commercial exploitation.  What you get for registering
  10. is the ability to interface your OWN GPS/WX/DF unit and a little convenience
  11. in saving configuration files as shown on the F1(help)-V page. 
  12.  
  13. These APRS formats are provided for use in the amateur radio service.  Anyone
  14. is encouraged to apply the APRS formats in the TRANSMISSION of position,
  15. weather, and status packets.  However, the author reserves the ownership of
  16. these protocols for exclusive commercial application and for all reception
  17. and plotting applications.  APRS is a trademark of Bob Bruninga.  Other 
  18. software engineers desiring to include APRS RECEPTION in their software 
  19. for sale within or outside of the amateur community will require a license 
  20. from the author.  Also TRANSMISSION of APRS protocols in any NON-AMATEUR 
  21. commercial application or software will require a license from the author.  
  22. See COMMERCL.txt
  23.  
  24.      All APRS communication is done using UI frames which retain all of the
  25. error detection capability of standard packets, but without acknowledgment.
  26. In APRS, collisions or lost packets are not a problem since information is
  27. redundantly transmitted (AND effeciently! due to the decaying transmission
  28. periods).  UI packets are the same type that are sent by a TNC using its
  29. BEACON and BText commands.  NOTE, however, that the APRS UI packets are
  30. generated internally in the APRS software and the TNC BText is not used 
  31. while APRS is running.
  32.  
  33.      APRS does use the UNPROTO command of the TNC to tell it what path
  34. to use for the transmittion of each packet.  But when we refer to the 
  35. UNPROTO command in APRS, we are refering to the APRS UNPROTO or OPS-UNPROTO
  36. command which then in turn issues the hardware UNPROTO commands to the TNC.
  37.  
  38. TO ADDRESS:   One caution; since APRS operates in a broadcast fashion and
  39. does not use a connected protocol, the TO ADDRESS is not required.  To 
  40. help ignore non-APRS traffic which might also be on the channel, APRS 
  41. stations use the TO ADDRESS field as a type of filter.  APRS will only 
  42. recognize UI packets transmitted to the broadcast addresses of ID, CQ, 
  43. QST, BEACON, MAIL, SKYWRN,GPS, DFNET, SPCL, TEST, DRILL and APRS.  All 
  44. other packets are ignored.  APRS does have the CONTORLS-OTHER command to 
  45. over-ride this filter temporarily.  There is also a alt-SETUP-MODES-SPECIAL
  46. command which turns off all of the above acceptible TO calls and will only 
  47. accept packets addressed TO: SPCL.  Similarly, these stations all transmit 
  48. using the UNPROTO path of SPCL via XXXX...  This makes it easy for a 
  49. sub-group of APRS users to operate a special event on the same frequency 
  50. as other APRS users, but to not be encumbered with all of their traffic.
  51.  
  52. APRS FORMATS:  The following paragraphs describe the various APRS on-air
  53. formats.  Abbreviations are D for degrees (or DAY), M for minutes (Both 
  54. lat/long and time), h for hundredths (or Hours), N for North and W for 
  55. West.  The delimiter following the Longitude is used to indicate the
  56. type of APRS symbol to be displayed (shown here as a $).  See the SYMBOLS
  57. .TXT file.  There are three types of time for local, zulu and hhmmss.  
  58.  
  59.  
  60. POSITION REPORT:  For a digipeater or permanent TNC, use the FIXED position
  61. report.  Mobiles will time stamp their position with the DAY,HOUR,MINUTE of
  62. the posit.  For a home TNC that normally runs APRS, the @ is replaced with
  63. a / to show the time of when APRS was last running.  If the symbol char
  64. is a backslash (\) then APRS assumes the report includes a DF line of 
  65. bearing for direction finding.  To be compatible with TheNET node ID frames, 
  66. the fixed format (starting with !) can occur anywhere in the BText.
  67.  
  68.    FIXED:   ...    !DDMM.hhN/DDDMM.hhW$comments...   (See DIGIS.txt)
  69.    APRS TNC:/DDHHMM/DDMM.hhN/DDDMM.hhW$comments...   
  70.    MOBILE:  @DDHHMM/DDMM.hhN/DDDMM.hhW$CSE/SPD/comments...
  71.    DF:      @DDHHMM/DDMM.hhN/DDDMM.hhW\CSE/SPD/BRG/90Q/Comments ( Q=quality)
  72.             .......z............................. (indicates Zulu date-time)
  73.             ......./............................. (indicates LOCAL date-time)
  74.             .......h............................. (Zulu time in hhmmss)
  75.    GRDSQR:  [XXnnyy]comments to end of line
  76.             [XXnn]comments to end of line
  77. W3AB>FM19SX:Hello there....                       (Space/MScat/Grid-SQ mode)
  78.    POWER:   ..........................$PHGabcd... (Power,ant/height/Gain.  See)
  79.                                                   (format below for digi's)
  80.    OMNI-DF: ..........................\DFSxbcd... (Same as PHG, but x=sig str)
  81.    TNC:     /DDHHMM.............................. (If the leading symbol is a )
  82.                                                   (/ instead of an @, then the)
  83.             (packet is NOT generated by  APRS software,  but usually by a dumb)
  84.             (terminal or TNC.   The Date-Time indicates when APRS was last on.)
  85.        
  86.    RTTY:    APRS DE WB4APRx/011427/3859.11'07629.11($ ...   This special format
  87.    uses only the RTTY subset of the ASCII alphabet where ',)( mean N,S,E & W,
  88.    and the x is an SSID number and the $ is the APRS symbol character.  The
  89.    ... comment field can contain the normal APRS CSE/SPD.  The callsign must
  90.    be padded to six spaces.  To enable parsing of this format, use alt-A.
  91.  
  92.  
  93. POWER-HEIGHT-GAIN:  This optional field replaces the CSE/SPD fields with a
  94. report of transmitter power, antenna height-above-average-terain and their
  95. antenna gain.  With this information, APRS can plot communication range
  96. circles around all stations.  This reporting capability should be an 
  97. excellent tool for all TNC's not just those used for APRS, such as for 
  98. BBS's and NODES.  The following details the format to be used in the BText 
  99. of a TNC dedicated as an APRS digipeater:
  100.  
  101.     !DDMM.mmN/DDDMM.mmW#PHG5360/WIDE...(identifying comments)...
  102.       |         |      | | ||||  |_____ makes station show up green
  103.       |         |      | | ||||________ Omni (Direction of max gain)
  104.       |         |      | | |||_________ Ant gain in dB
  105.       |         |      | | ||__________ Height = log2(HAAT/10)
  106.      LAT      LONG     | | |___________ Power = SQR(P)
  107.                        | |_____________ Power-Height-Gain identifier *
  108.                        |_______________ # is symbol for digipeater
  109.  
  110.      As you can see by the integers in the Pwr string, there are only 10
  111.      possible values for each of these fields as follows:
  112.  
  113.      DIGITS   0  1  2   3   4   5   6    7    8    9         Equation
  114.      -------------------------------------------------------------------
  115.      POWER    0, 1, 4,  9, 16, 25, 36,  49,  64,  81  watts  SQR(P)
  116.      HEIGHT  10,20,40, 80,160,320,640,1280,2560,5120  feet   LOG2(H/10)
  117.      GAIN     0, 1, 2,  3,  4,  5,  6,   7,   8,   9  dB
  118.      DIR      0,45,90,135,180,225,270, 315, 360,   .  deg    (D/45)
  119.  
  120.      The DIRECTIVITY field offsets the PHG circle by one third in the
  121.      indicated direction.  This means a front to back range of 2 to 1.
  122.      Most often this is used to indicate a favored direction or a null
  123.      even though an OMNI antenna is at the site.  Note that 0 means
  124.      OMNI and 8 means 360 or a NORTH offset.
  125.  
  126.      THESE HIGHTS are ABOVE-AVERAGE TERRAIN!  Not above ground or sea
  127.      level.  Your antenna may be at 1000 ft above sealevel and be on 
  128.      a 100 foot tower.  But if you go out 10 miles in all directions
  129.      and find that the average elevation is 1100 feet, then your
  130.      height-above-averag-terain is ZERO!!!!
  131.  
  132.  
  133. OMNI-SIGNAL-STRENGTH DIRECTION FINDING REPORT:  Ssince APRS can plot range 
  134. circles around all stations, it was easy to add the capability to localize 
  135. hidden transmitters by simply plotting the overlapping signal strength 
  136. contours of all stations hearing the transmitter.  In this instance, the 
  137. PHG format identifier is replaced with DFS to indicate DF Signal strength, 
  138. and the transmitter power field is replaced with the relative signal 
  139. strength on an arbitrary scale of 0 to 9.  The following beacon would
  140. represent a weak signal heard on an antenna with 3 dB gain at 40 feet:
  141.  
  142.    @141923/3859,11N/07629.23W\DFS2230/comments
  143.  
  144.    Although the backslash (DF) station symbol was used, this report will
  145.    work no matter what the station symbol.  A report with a signal of
  146.    ZERO (0), is SIGNIFICANT beacuse APRS uses these 0 signal reports
  147.    to draw BLACK circles where the transmitter is KNOWN NOT to be.  These 
  148.    BLACK circles where the transmitter IS NOT are actually VERY useful,
  149.    since many more people will NOT hear the fox than will.  The black
  150.    circles will eliminate a lot of territority where the fox is NOT.
  151.  
  152.  
  153. WEATHER REPORT:  APRS uses the underline symbol character for WX reports.
  154. For these, the COURSE/SPEED field is used for WIND direction and speed.
  155. The remainder of the comment line can contain any other weather items.  
  156. See WX.TXT for details on the specific format of the optional automatic 
  157. Home weather station interface for the Ultimeter-II.
  158.  
  159.     @DDHHMM/DDMM.hhN/DDDMM.hhW_CSE/SPD/T073/R00h/WxStn (auto)
  160.                                        Dxxx/Pxxh/Bxxx other optional
  161.                                        fields for DewPt, Participation
  162.                                        accumulation, and BaroPressure
  163.     The R field is tenths of an inch of rain in the LAST HOUR
  164.     The P field is tenths of an inch of rain in the LAST 24 HOURS
  165.           (if hundredths are available, an optional 3rd digit may be added)
  166.     An  S filed is INCHES of snow in the last 24 hours
  167.     The (auto) indicates the report is automatic and therefore current.
  168.  
  169. OBJECT POSITION:  To report the position of something other than your own
  170. station, the same format for a mobile object is used but it is preceeded with
  171. a nine digit object name.  For shorter names, the 9 character field must be
  172. padded with spaces:
  173.  
  174.     OBJECT___*DDHHMM/DDMM.hhN/DDDMM.hhW$CSE/SPD/comments...
  175.     
  176. ALL OTHER PACKETS:  Any packet that does NOT meet any of the above formats
  177. is assumed to be just a status beacon and is placed on the LATEST list.  
  178. APRS automatically places the date-time at the beginning of such packets
  179. so the receiver will know when that status or beacon was sent.
  180.  
  181.     @DDHHMM/comments...
  182.  
  183. MESSAGE: To direct a specific message to a specific station and have his bell
  184. ring and the message instantly flashed on his screen, use the following format,
  185. again padding the addressee call with spaces to a total of nine characters
  186. followed by a colon:
  187.  
  188.     W3XYZ____:one line message text......{3 (the {3 is the line counter)
  189.  
  190.     His station will acknowledge receipt with a responding message
  191.     to you with only the letters ACK3 in the message.
  192.  
  193. MSG ACK: If an APRS station sends you a message line, it will be repeated
  194. over and over until you send a responding ack.  To send an ack to station
  195. W3XYZ, simply enter his call padded to nine spaces and a colon followed by
  196. the letters ACK# where the # is the line number tacked onto the end of his
  197. message line with a ({).
  198.  
  199.     W3XYZ____:ack3
  200.  
  201. BULLETINS: Each station can also send a multiple line BULLETIN to ALL 
  202. stations by simply sending multiple single line messages to the special 
  203. call signs of BLN1, BLN2, ... BLN#.  All APRS stations collect all such 
  204. BLN# messages and sort them onto the special BULLETINS page.  They are 
  205. also sorted by originators call, so that many stations can have 
  206. BULLETINS flying at the same time.  You may change any BLN# line at 
  207. anytime, and all receiving stations will simply over-write the line with 
  208. the latest line.  Bulletins sent BLN# will decay to very long periods
  209. but bulletins sent to BLNx will decay down to once every 15 minutes and
  210. stay at that rate. 
  211.  
  212. APRS QUERIES: APRS responds to several general queries:
  213.  
  214.      ?APRS? - All stations respond with all outgoing status, posits, OBJs
  215.               and messages randomly over 2 minutes (4 on HF)
  216.      ?APRS?LLLLLL,OOOOOO,RRRR - Only stations within RRRR miles of the
  217.               LLLLLL Latitude and OOOOOO Longitude respond.  If RRRR is
  218.               less than 8 (64 on HF) then respond immediately
  219.      ?WX? -   All WX stations respond
  220.      MYCALL...:?APRS? - Only the station MYCALL responds immediately
  221.  
  222. DF REPORTS:  The DF report includes a N0Q field in addition to the
  223. position, course and speed of the vehicle plus the bearing line.
  224.  
  225.      @DDHHMM.xxN/DDDMM.xxW\CSE/SPD/BRG/N0Q/DF report...
  226.  
  227.      N0Q is a Quality indicator where Q is a quality value (1-8) amd
  228.      N is an optional Number of HITS indicator. If N is 0, then it means 
  229.      nothing.  Values from 1 to 8 give an indication of the number of 
  230.      hits per period relative to the length of the time period.  So 8 
  231.      means 100% of all samples possible, got a hit.  The N is not 
  232.      processed, but is just another indicator from the automatic DF 
  233.      units.  By entering a 9 as the HIT indicator, you can indicate to 
  234.      other users that your report is manual.
  235.  
  236.  
  237. DIGIPEATERS, NODES, BBS's AND ALL OTHER PACKET STATIONS:
  238.  
  239. Since APRS is a generalized position displaying tool, EVERY Packet TNC that
  240. is permanently on the air, and that also transmits a periodic ID beacon,
  241. should be reporting its position in that ID beacon!  This way, stations
  242. monitoring can quickly see a geographical plot of the network.  If you want
  243. to keep the exact location of your transmitter ambiguous, then use
  244. the GRID-SQUARE format, and your position will be ambiguous to a few miles,
  245. but stations can still see that you are on the air.  If you have special
  246. formats for your BEACONS that contain variable information, then APRS is
  247. perfect for grabbing that information and making it available to users...
  248. If you have any uused aliases, set them to RELAY so others can find you.
  249.  
  250.